tr1p1ea - 08/06/2005 (dd/mm/yyyy)
---------------------------------

xLIB v0.501b:
------------

xLIB is now an APP that adds some functionality to TI-83+ BASIC programs. It installs a
parser hook which will intercept any real( requests.

To install xLIB simply copy "xLIB.8xk" to your calc using your favoutrite flavour of linking
software.

To enable xLIB you must run it from the APPS menu and select '1'. A message should appear
informing you that xLIB has been enabled. Pressing '2' will disable xLIB and '3' will quit.


0 - ClearScreen:
----------------
usage: real(0

This function Clears the graph buffer and the LCD.


1 - DrawSprite:
---------------
usage: real(1,Spr_X,Spr_Y,Spr_Width,SprHeight,sPIC_Num,sPIC_X,sPIC_Y,Spr_Method,Spr_Flip,Spr_UpDateLCD

Spr_X = Sprite X location
Spr_Y = Sprite Y location
Spr_Width = Sprite width in BYTES (so a 16 pixel wide sprite would have a width of 2)
Spr_Height = Sprite height in pixels
sPIC_Num = The PIC in which the sprite is located PIC0 - PIC9
sPIC_X = X offset to sprite in PIC, must be ALIGNED. Can be a value from 0-11
sPIC_Y = Y offset to sprite in PIC
Spr_Method = The copy method 0 = Overwrite, 1 = AND, 2 = OR, 3 = XOR
Spr_Flip = Flip Sprite 0 = No Flip, 1 = Horizontal Flip
Spr_UpdateLCD = Toggle LCD update 0 = No, 1 = Yes

This function will draw clipped sprites of ANY size anywhere on the screen.

Dont forget that sprites always have a width which is a multiple of 8. However with this routine we
want the BYTE width of the sprite. It is 8 pixels per byte! So a 8x8 sprite has a BYTE width of 1,
a 16x16 sprite would have a BYTE width of 2. A 12x12 sprite would still occupy 2 BYTES so it also has a
BYTE width of 2.

sPIC_X is only at ALIGNED positions, can be a value from 0-11
sPIC_Y can be from 0-63

Horizontal Sprite Flipping has now been implemented. This should save you some space.


2 - DrawTileMap:
----------------
usage: real(2,Matrice_Name,X_Offset,Y_Offset,MapWidth,MapHeight,ScreenStartX,
ScreenEndX,ScreenStartY,ScreenEndY,mPIC_Num,Tile_Method,Map_UpdateLCD

Matrice_Name = Name of matrice containing map data 0 - 9. 0 = [A] - 9 = [J]
X_Offsett = X Map Offsett. Which part of the map you wish to start drawing at
Y_Offsett = Y Map Offsett. Which part of the map you wish to start drawing at
MapWidth = Width of TileMap
MapHeight = Height of TileMap
ScreenStartX = Which COLUMN you wish to START drawing. Can be a value from 0-12
ScreenEndX = Which COLUMN you wish to END drawing at. Can be a value from 0-12
ScreenStartY = Which ROW you wish to START drawing. Can be a value from 0-8
ScreenEndY = Which ROW you wish to END drawing at. Can be a value from 0-8
mPIC_Num = The PIC in which the tile data is located PIC0 - PIC9
Tile_Method = The copy method 0 = Overwrite, 1 = AND, 2 = OR, 3 = XOR
Map_UpdateLCD = Toggle LCD update 0 = No, 1 = Yes

The ScreenStartX, ScreenEndX, ScreenStartY, ScreenEndY enable you to draw a 'windowed' map. This means that you can draw
your map and leave space for a HUD or something similar. Drawing smaller maps will also be a little faster.

To draw a map centered with a 1 tile blank border the inputs would be:

ScreenStartX = 1
ScreenEndX = 11
ScreenStartY = 1
ScreenEndY = 7

The TileMap routine now supports MULTIPLE PICS! Now your maps can have 256 different tiles instead of only 96.
If a tilenumber is > 95 it will be taken from the second PIC, if the tilenumber > 191 then it will be taken from the 3rd PIC.
You cant use all of the 3rd PIC as 256th tile comes about 3/4 down.

PICS must follow each other numerically!!!!

So if your input PIC is PIC0 any tiles > 95 will be taken from PIC1 and any tiles > 191 will be taken from PIC2.

If the PIC doesnt exist then the tile will be drawn as a BLANK.


3 - RecallPIC
-------------
usage: real(3,rPIC_Num,rPIC_Method,Recall_UpdateLCD

rPIC_Num = PIC to recall PIC0 - PIC9
rPIC_Method = The copy method 0 = Overwrite, 1 = AND, 2 = OR, 3 = XOR
Recall_UpdateLCD = Toggle LCD update 0 = No, 1 = Yes

This will recall a pic and display it with some options (OR, XOR etc)


4 - ScrollScreen
----------------
usage: real(4,Scrl_Direction,Scrl_Number,Scrl_UpdateLCD

Scrl_Direction = direction to scroll
Scrl_Number = number of pixels to scroll
Scrl_UpdateLCD = Toggle LCD update 0 = No, 1 = Yes

Directions:

0 - Up
1 - Down
2 - Left
3 - Right
4 - UpLeft
5 - UpRight
6 - DownLeft
7 - DownRight


5 - ChangeContrast
------------------
usage: real(5,ContrastVal

ContrastVal = New contrast value. Can be a value from 0-39


6 - UpdateLCD
-------------
usage: real(6

This function will copy the graph buffer to the LCD


End of Functions List.


*WARNING*: You MUST provide the correct inputs for each function. If you do not you
risk a crash or worse.

DO NOT TRY TO RUN YOUR BASIC PROGRAM FROM MIRAGEOS!!!! I use a saferam area that MirageOS uses,
it may cause instability.

Disclaimer:
-----------
This program is still in early stages and may contain bugs. Program is use at own risk,
I can not be held responsible for loss of data and or hardware damage.

If you have any questions please email me at: tr1p1ea@yahoo.com.au

I have no problem with anyone using this program as long as you credit me
properly. Please dont try to modify and/or pass this program off as your
own with out first gaining my consent.
